Transforms forPreferencesBean


PreferencesGeneralTransform

Formal Parameter Type Default Required Description
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
availableSize INTEGER 5 false Specifies the size of the Available listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
Usage: This may be changed to customize the size of the listboxes on the shopping cart.
colorThemePickerName STRING colorThemePicker false Indicates the name of the system picker that contains the color themes that shall be displayed to the user as possible options for color theme in preferences section of the application.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
createPageName STRING create false Specifies the name of the page that displays the contents of Create Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
documentBeanName STRING db false Specifies the name of the bean that displays the documents' content. Used on the 'Default start page' section of the preferences.
The value defined here has to be the same name assigned to the document bean defined on the Page Configuration File page definition that will be running the document.
documentPageName STRING document false Specifies the name of the page that displays the documents' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    folderBeanName STRING fb false Specifies the name of the bean that displays the folders' contents. Used on the 'Default start page' section of the preferences.
    The value defined here has to be the same name assigned to the folder bean defined on the Page Configuration File page definition that will be showing the contents.
    fontNamePickerName STRING fontPicker false Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for fonts to use on the application.
    formID STRING PreferenceForm false Specifies the ID to use for the preferences' HTML Form.
    Allowed Values:
    Any string allowed in an ID tag of an HTML form.
    Usage:
    This may be changed to execute some Javascript that needs to make reference to the preferences form with a specific name.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    html5viPageName STRING Html5Vi false  
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    levelFlag INTEGER -1 false Indicates the level of information to use when displaying the preferences bean.
    The information include the preferences section, the apply to select box and the load defaults button Default value is AbstractPreferencesTransform.LEVEL_ALL
    myPageName STRING my false Specifies the name of the page that displays the contents of My Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.
    oivmPageName STRING oivm false Indicates the name of the oivm document
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    reportBeanName STRING rb false Specifies the name of the bean that displays the reports' content. Used on the 'Default start page' section of the preferences.
    The value defined here has to be the same name assigned to the report bean defined on the Page Configuration File page definition that will be running the report.
    reportFrameBeanName STRING frame false Specifies the name of the bean that contains the report bean and other editor/toolbar beans. Used on the 'Default start page' section of the preferences.
    The value defined here has to be the same name assigned to the report frame bean defined on the Page Configuration File page definition that will be running the report.
    reportPageName STRING report false Specifies the name of the page that displays the reports' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    rwDocumentBeanName STRING rwb false Specifies the name of the bean that displays the report writing documents' content. Used on the 'Default start page' section of the preferences.
    The value defined here has to be the same name assigned to the report writing document bean defined on the Page Configuration File page definition that will be running the document.
    rwDocumentPageName STRING rwd false Specifies the name of the page that displays the report writing documents' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    searchObjectTypesPickerName STRING searchObjectTypesPicker false Indicates the name of the system picker that contains the all search object types that shall be displayed to the Admin user as available options for search object types in preferences section of the application.
    selectedSelectSize INTEGER 5 false Specifies the size of the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
    Usage: This may be changed to customize the size of the listboxes on the shopping cart.
    sharedPageName STRING shared false Specifies the name of the page that displays the contents of Shared Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.
    startPagesPickerName STRING startPagesPicker false Indicates the name of the system picker that contains the start pages that shall be displayed to the user as possible start pages in the application.
    timeZonesPickerName STRING timeZonesPicker false Indicates the name of the system picker that contains the time zones that shall be displayed to the user as possible options for time zones in preferences section of the application.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.